Interface ClassMap

All Superinterfaces:
IPCObject
All Known Implementing Classes:
ClassMapImpl

public interface ClassMap extends IPCObject
Information provided by the PKI file:

    \class ClassMap
    
    \brief ClassMap handles the class maps for QoS.
    
    \example network().getDevice("Router0").getClassMapManager().getClassMapAt(0)
    
Author:
Auto-generated
  • Method Details

    • getMapName

      String getMapName()
      Information provided by the PKI file:
      
          \brief Returns the class map name.
          
          \return string, the class map name.
          
              
      Returns:
      String Returns a String
    • setDescription

      void setDescription(String description)
      Information provided by the PKI file:
      
          \brief Sets the class map description.
          
          \param description, the class map description.
          
              
      Parameters:
      description - Takes in a parameter of description
    • getDescription

      String getDescription()
      Information provided by the PKI file:
      
          \brief Returns the class map description.
          
          \return string, the class map description.
          
              
      Returns:
      String Returns a String
    • getMatchTypeString

      String getMatchTypeString()
      Information provided by the PKI file:
      
          \brief Returns the class map match types.
          
          \return string, the class map match types.
          
              
      Returns:
      String Returns a String
    • getMatchType

      ClassMapMatchType getMatchType()
      Information provided by the PKI file:
      
          \brief Returns the class map match type.
          
          \return QoS::EClassMapMatchType,    the class map match type.
          Match types:        eMatchAny = 0,
          eMatchAll = 1
          
              
      Returns:
      ClassMapMatchType Returns a ClassMapMatchType
    • setMatchType

      void setMatchType(ClassMapMatchType matchType)
      Information provided by the PKI file:
      
          \brief Sets the class map match type.
          
          \param QoS::EClassMapMatchType,     the class map match type.
          Match types:        eMatchAny = 0,
          eMatchAll = 1
          
              
      Parameters:
      matchType - Takes in a parameter of matchType
    • toReverseString

      String toReverseString()
      Information provided by the PKI file:
      
          \brief Returns the class map string.
          
          \param string, the class map string.
          
              
      Returns:
      String Returns a String
    • toString

      String toString()
      Information provided by the PKI file:
      
          \brief Returns the class map reverse string.
          
          \param string, the class map reverse string.
          
              
      Overrides:
      toString in class Object
      Returns:
      String Returns a String
    • getMapType

      MapType getMapType()
      Information provided by the PKI file:
      
          \brief Returns the class map type.
          
          \return QoS::eMapType,      the map type.
          Map types:  type_default = 0,
          type_control = 1,
          type_inspect = 2,
          type_logging = 3
          
              
      Returns:
      MapType Returns a MapType
    • setMapType

      void setMapType(MapType mapType)
      Information provided by the PKI file:
      
          \brief Sets the class map type.
          
          \param mapType,     the map type.
          Map types:  type_default = 0,
          type_control = 1,
          type_inspect = 2,
          type_logging = 3
          
              
      Parameters:
      mapType - Takes in a parameter of mapType
    • getStatementCnt

      int getStatementCnt()
      Information provided by the PKI file:
      
          \brief Returns the number of statements in this class map.
          
          \return int, the number of statements in this class map.
          
              
      Returns:
      int Returns a int
    • isClassDefault

      boolean isClassDefault()
      Information provided by the PKI file:
      
          \brief Returns true if this class map is class-default, otherwise false.
          
          \return bool, true if this class map is class-default, otherwise false.
          
              
      Returns:
      boolean Returns a boolean